https-proxy-agent

What is https-proxy-agent?

The https-proxy-agent package is a Node.js module that provides an http.Agent implementation that connects to a specified HTTP or HTTPS proxy server, and can be used with the http or https modules to make requests. It is particularly useful for making requests from behind a corporate firewall or when you need to use a proxy for requests for any other reason.

What are https-proxy-agent's main functionalities?

Creating an HTTPS proxy agent

This code sample demonstrates how to create an HTTPS proxy agent using the https-proxy-agent package and use it to make an HTTPS request.

const HttpsProxyAgent = require('https-proxy-agent');
const https = require('https');

const proxy = 'http://proxy-server:port';
const agent = new HttpsProxyAgent(proxy);

https.get({
  hostname: 'encrypted.google.com',
  path: '/',
  agent: agent
}, (res) => {
  console.log(`Got response: ${res.statusCode}`);
  // consume response body
  res.resume();
}).on('error', (e) => {
  console.error(`Got error: ${e.message}`);
});

Other packages similar to https-proxy-agent

http-proxy-agent

This package provides an http.Agent implementation for HTTP, similar to https-proxy-agent but for non-encrypted HTTP connections. It is useful when you need to proxy HTTP requests specifically.

socks-proxy-agent

The socks-proxy-agent package is similar to https-proxy-agent but is designed to work with SOCKS proxy servers. It provides an http.Agent implementation that connects to a SOCKS proxy server, which can be used for both HTTP and HTTPS requests.

tunnel-agent

Tunnel-agent is another Node.js module that allows you to tunnel HTTP and HTTPS requests through HTTP proxies. It is similar to https-proxy-agent but offers more customization options for creating tunnels, such as allowing you to specify headers for CONNECT requests.

README

https-proxy-agent

An HTTP(s) proxy http.Agent implementation for HTTPS

This module provides an http.Agent implementation that connects to a specified HTTP or HTTPS proxy server, and can be used with the built-in https module.

Specifically, this Agent implementation connects to an intermediary "proxy" server and issues the CONNECT HTTP method, which tells the proxy to open a direct TCP connection to the destination server.

Since this agent implements the CONNECT HTTP method, it also works with other protocols that use this method when connecting over proxies (i.e. WebSockets). See the "Examples" section below for more.

Examples

https module example

import * as https from 'https';
import { HttpsProxyAgent } from 'https-proxy-agent';

const agent = new HttpsProxyAgent('http://168.63.76.32:3128');

https.get('https://example.com', { agent }, (res) => {
  console.log('"response" event!', res.headers);
  res.pipe(process.stdout);
});

ws WebSocket connection example

import WebSocket from 'ws';
import { HttpsProxyAgent } from 'https-proxy-agent';

const agent = new HttpsProxyAgent('http://168.63.76.32:3128');
const socket = new WebSocket('ws://echo.websocket.org', { agent });

socket.on('open', function () {
  console.log('"open" event!');
  socket.send('hello world');
});

socket.on('message', function (data, flags) {
  console.log('"message" event! %j %j', data, flags);
  socket.close();
});

API

new HttpsProxyAgent(proxy: string | URL, options?: HttpsProxyAgentOptions)

The HttpsProxyAgent class implements an http.Agent subclass that connects to the specified "HTTP(s) proxy server" in order to proxy HTTPS and/or WebSocket requests. This is achieved by using the HTTP CONNECT method.

The proxy argument is the URL for the proxy server.

The options argument accepts the usual http.Agent constructor options, and some additional properties:

• headers - Object containing additional headers to send to the proxy server in the CONNECT request.